home *** CD-ROM | disk | FTP | other *** search
/ Amiga News 96 / Amiga News 96.iso / amig_ad_os / a.f.l.e. / zaphod / docs / english / zaphod10englisch.doc next >
Text File  |  1994-06-03  |  15KB  |  375 lines
  1.           Zaphod, a binary editor for AMIGA computers
  2.                           Release 1.0
  3.  
  4.                         Holger Schemel
  5.                   aeglos@valinor.ms.sub.org
  6.  
  7.                          June 3, 1994
  8.  
  9.  
  10. Contents
  11.  
  12. 1. Copyright and all that
  13. 2. About Zaphod
  14. 3. Installation
  15. 4. Starting Zaphod from Workbench and Shell
  16. 5. The usage of the program
  17.    5.1 The main window of Zaphod
  18.        5.1.1 The gadgets
  19.        5.1.2 The edit field
  20.    5.2 The menues
  21.        5.2.1 Project
  22.        5.2.2 Edit
  23.        5.2.3 Settings
  24.        5.2.4 Files
  25. 6. Credits
  26. 7. Bug reports and others
  27.  
  28.  
  29. 1. Copyright and all that
  30.  
  31. Zaphod is copyrighted software (C) 1993-94 by Holger Schemel.
  32.  
  33. The program may be freely distributed with the following restrictions:  The
  34. The archive and all its contents may not be changed, and no  files  may  be 
  35. removed or added to the archive. 
  36. All rights reserved.
  37.  
  38. No guarantee of any kind is given that the programs described in this docu-
  39. ment are 100\% reliable. You are using this material at your own risk.  The 
  40. author can not be made responsible for any damage which is caused by  using 
  41. these programs.
  42.  
  43. This package can be included in public domain collections, including  those 
  44. on CD-ROM. The distribution file may be uploaded to Bulletin Board  Systems 
  45. or FTP servers. None of the program nor parts of it may be included or used 
  46. in commercial programs without a written permission from the author.
  47.  
  48. If you have paid more than $5, it's yout own fault.
  49.  
  50. The usage of this program close by nuclear power  stations,  the  usage  of 
  51. weapons and military equipment and the consumption of radio  active  hazel-
  52. nuts is your own risk!
  53.  
  54. 2. About Zaphod
  55.  
  56. Zaphod is a file editor for binary files in the tradition of  classic  pro-
  57. grams like ``FileZap'' and ``NewZap''. However, it is written to  use  fea-
  58. tures of AmigaOS 2.0 so you need this or a higher version of the Amiga ope-
  59. ration system to use this program. The usage with OS 3.0 or  higher  should
  60. not make any problems.
  61.  
  62. This file editor lets you edit several files at a time. The files you  want 
  63. to edit can be marked with the mouse button while holding the  'shift'  key 
  64. right at the start from Workbench, chosen  from  the  ASL  file  requester, 
  65. chosen by dropping their icons into the window or, if  you  started  Zaphod 
  66. from shell, by specifying the files as parameters after the program name.
  67.  
  68. The program window of Zaphod opens on the  Workbench,  on  a  given  public 
  69. screen or on its own public screen which will then be  named  ZAPHOD.1  (or 
  70. ZAPHOD.x, if you started Zaphod x times with its own screen). If you  star-
  71. ted Zaphod on a public screen, you can drop icons into it by  simply  drop-
  72. ping them on the  application  icon,  which  has  the  name  ZAPPICON.1  or 
  73. ZAPPICON.x. You can get Zaphod's  public  screen  into  the  foreground  by 
  74. double-clicking on its application icon.
  75.  
  76. The whole settings of the program can be given and were saved in the  Tool-
  77. Types in the program icon. If you start it from shell, give the settings as 
  78. program parameters. At the time there is no support for an extra configura-
  79. tion file, so if you want to start it from shell regularly, make  an  alias 
  80. in 's:user-startup' of the form 'alias zaphod zaphod <configuration parame-
  81. ters>'.
  82.  
  83. 3. Installation
  84.  
  85. Just copy the whole drawer at the place you want to have it. It's enough to 
  86. have the files ``Zaphod'' and ``Zaphod.info''.
  87.  
  88. If you  have  installed  AmigaOS 2.1  or  above,  you  can  copy  the  file 
  89. ``zaphod.catalog'' into ``LOCALE:Catalogs/<your language>''. At this  time, 
  90. there is only a catalog for German language.
  91.  
  92. Additionally, there are some extra fonts in the ``Zaphod/fonts'' directory. 
  93. The ``topaz'' variations are non-proportional, the ``tripaint''  fonts  are 
  94. proportional ones. Just try them out (They must be  copied  to  your  local 
  95. ``FONTS:'' directory). These fonts are designed to  be  small  or  thin  or 
  96. both, so you can use them to display more data in the  Zaphod  edit  window 
  97. than with the standard system fonts.
  98.  
  99. 4. Starting Zaphod from Workbench and Shell
  100.  
  101.  
  102. The ToolTypes are the same as the shell parameters, that means if you  have
  103. a ToolType of the form 'TOOLTYPE=PARAMETER', then you can give this exactly 
  104. as a shell parameter (you can use a blank instead of the ``='').
  105. (See the descriptions of the menu 'Settings' for more information.)
  106.  
  107. The ToolTypes are:
  108.  
  109. LEFT:
  110.        Left position the window opens.
  111. TOP:
  112.     Top position the window opens.
  113. LINES:
  114.     The number of lines displayed in the edit window.
  115. COLUMNS:
  116.     The number of longwords (four data bytes) per line in the edit win-
  117.         dow.
  118. TEXTFONTNAME:
  119.     Here you can choose the text font of the Zaphod window. '<default>' 
  120.     uses the system font choosen in your system preferences.
  121. TEXTFONTSIZE:
  122.     Choose the size of the font. {\tt <default>} uses the  system  size
  123.     again.
  124. EDITFONTNAME:
  125.     Here you can choose the edit font, which is used in the edit  field
  126.     of the Zaphod window. '<default>' uses  the  non-proportial  system 
  127.     font again. It is recommended to use one of the fonts shipped  with 
  128.     Zaphod to be able to display more characters than with  the  system 
  129.     fonts. If you don't like them, you can get the font editor FEd from 
  130.     AmigaOS 1.3 and create your own fonts for Zaphod.
  131. EDITFONTNAME:
  132.     The size of the chosen edit font.
  133. PUBSCREEN:
  134.     Here you can specify the name of a public screen  on  which  Zaphod 
  135.     shall open its window on. If you specify 'WBENCH',  the  window  is 
  136.     opened on the Workbench. With 'OWNSCREEN' you can advise Zaphod  to 
  137.     open its own public screen, which is then given the name  ZAPHOD.x, 
  138.     where x is the number of the instance of Zaphod with an own  public 
  139.     screen.
  140. EXPERTMODE:
  141.     This parameter tells Zaphod how often it should ask  for  confirma-
  142.     tion. You should start with 'NORMAL'. If you don't want to see  too 
  143.     many questions ``Do you really want...?'', then choose  'MODERATE'. 
  144.     With 'EXPERT', Zaphod asks no  more  questions;  only  choose  this 
  145.     option if you really know what you're doing.
  146. HEXDESIGN:
  147.     Choose 'UPPER' to have upper case  characters  in  the  hexadecimal 
  148.     edit field and 'LOWER' to have lower case characters.
  149. SIZEGADGET:
  150.     Choose 'RIGHT' to have the wider window border with the size gadget 
  151.     on the right window border and 'BOTTOM' to have it  on  the  bottom 
  152.     border.
  153. LOADMODE:
  154.     You can choose  'INSERT_ONE',  'INSERT_ALL'  or  'APPEND_ALL'.  See 
  155.     'Settings / Files' for a description.
  156. CLIPMODE:
  157.     Choose 'INTERNAL' or 'EXTERNAL' for an internal or  external  clip-
  158.     board handling.
  159. CLIPNR_INTERNAL:
  160.     Choose the clip number used for internal clipboard handling.  Don't 
  161.     choose 0 here, because that's the clip number of the  system  clip-
  162.     board.
  163. CLIPNR_EXTERNAL:
  164.     Choose the clip number used for external clipboard handling. Better 
  165.     don't change it from the default value 0 here, because  that's  the 
  166.     clip number of the system clipboard.
  167. ADDRESSBOX:
  168.     Choose 'YES' or 'NO' to have the addresses field in the    edit window 
  169.     displayed or not.
  170. VIEWMODE:
  171.     Choose 'HEX', 'ASCII' or 'HEX&ASCII' to have the file contents dis-
  172.     played as hexadecimal values, ASCII characters or both.
  173.  
  174. If you start Zaphod from shell, you can specify up to ten files which  will 
  175. then be loaded to the file buffers. If  you  give  a  question  mark  here, 
  176. Zaphod will give you a command pattern known from the system commands.
  177.  
  178. 5. The usage of the program
  179.  
  180. 5.1 The main window of Zaphod
  181.  
  182. After starting Zaphod, you see the main window with the edit field and some
  183. gadgets. If you have already given some file names at the start, the  first 
  184. one will be displayed in the edit window (if it can be opened).
  185.  
  186. The file name of the file that is currently in the edit buffer will be dis-
  187. played in the title of the window.
  188.  
  189. 5.1.1 The gadgets
  190.  
  191. If you want to search for a byte sequence in the file, use the search  gad-
  192. gets below of the edit field. Type the byte sequence into the  string  gad-
  193. get; you can use ASCII characters or  hexadecimal  values  or  both  mixed. 
  194. Hexadecimal values must be two numbers preceeded with a `$' or a  `0x'.  If 
  195. these special characters are part of the search string, just put them  into 
  196. quotation marks.
  197.  
  198. Some examples:
  199. $20$20$3c
  200. 0x200x200x3c
  201. Test$00
  202. $20"Hello, World"0x00
  203.  
  204. To start searching, click onto the ``Search'' gadget or  press  the  under-
  205. lined character ('s'). If the search text was found,  the  cursor  will  be 
  206. placed on the first character of the text found in the file buffer. If  the 
  207. search was succesful can also be seen at the ``Status'' field.
  208.  
  209. The search directions can be chosen with the corresponding gadget.  At  the 
  210. search from the start or from the end, the status of  the  gadget  will  be 
  211. changed to searching behind/before the  cursor  to  allow  easy  sequential 
  212. searching.
  213.  
  214. Choose case dependency with the corresponding gadget.
  215.  
  216. At the left side, there are two gadgets showing the actual cursor  position
  217. in the file buffer and the length of the whole file. You can jump  directly
  218. to a certain file position with the first of these two gadgets.
  219.  
  220. Below of the gadgets for text searching there  are  gadgets  for  replacing 
  221. file contents with some other data. Just type the new  byte  sequence  into
  222. the ``Replace'' string gadget (with the same format as the search text) and 
  223. choose ``Replace'' instead of ``Search''.
  224.  
  225. With the gadget ``Replacemode'', you can choose if all matching texts shall 
  226. be replaced, only the next matching text or if there should be  a requester
  227. for each match.
  228.  
  229. All gadgets can be used by pressing the appropriate key, which is  the  key 
  230. in the gadget text that is underlined.
  231.  
  232. 5.1.2 The edit field
  233.  
  234. The edit field consists of up to three parts: the address field,  the hexa-
  235. decimal field and the ASCII field. All  three  can  be  scrolled  with  the 
  236. scrollbar at the right.
  237.  
  238. If you click into the edit field, you can type input directly into the file 
  239. buffer (where you can only use the number keys and the keys 'a' to 'z'  and
  240. 'A' to 'Z' in the hex field).
  241.  
  242. With the tabulator key, you can switch between the  hex  and  ASCII  field. 
  243. Move the cursor with the usual cursor keys, Shift-Up/Down moves to the  be-
  244. ginning/end of the file, Ctrl-Up/Down moves one page up or down.
  245.  
  246. 5.2 The menues
  247.  
  248. There are the following menues:
  249.  
  250. 5.2.1 Project
  251.  
  252. The ``Project'' menu has the following items:
  253.  
  254. New:
  255.     Clears the actual file buffer (not the file itself). All other file 
  256.     buffers remain untouched.
  257. Open
  258.     Opens a new file. Uses the ASL file requester.
  259. Save:
  260.     Saves the file under the name it was opened as or under the name it 
  261.     was already saved once.
  262. Save As...:
  263.     Like ``Save'', but asks for a file name with the ASL file requester.
  264. Print:
  265.     (Not yet implemented.)
  266. Print As...:
  267.     (Not yet implemented.)
  268. About...:
  269.     Short description about the program and the author and  the name of 
  270.     the screen the program is opened on.
  271. User...:
  272.     Information about the user of the program.
  273. Quit:
  274.     Quit the program. If there are any file buffers that  are  modified 
  275.     but unsaved, you will get a warning.
  276.  
  277. 5.2.2 Edit
  278.  
  279. These are the usual block  operation/clipboard  functions  (to  indicate  a 
  280. block, just mark it with the mouse as usual), as there are:
  281.  
  282. Cut:
  283.     Cut the marked block and put it into the clipboard.
  284. Copy:
  285.     Copy the marked block into the clipboard.
  286. Paste:
  287.     Paste the contents of the clipboard to the edit field (insert  them 
  288.     at the cursor position).
  289. Erase:
  290.     Erase the marked block without touching the clipboard.
  291. Undo:
  292.     Undo the last block operation.
  293.  
  294. 5.2.3 Settings
  295.  
  296. The ``Settings'' menu contains the following items:
  297.  
  298. Text font:
  299.     With 'automatic', choose the system  font.  With  'user  selected', 
  300.     choose  a  selected  font  for  window  and   gadget   text.   With
  301.     'select...', you can choose that font.
  302. Edit font:
  303.     The submenu items are the same and have the same functions like the 
  304.     options in the menu above, but you can  make  decisions  about  the 
  305.     font used in the edit field.
  306. Addresses:
  307.     Specify if you want to have the addresses field or not.
  308. Viewmode:
  309.     Specify if you want to see the file buffer contents as  hexadecimal 
  310.     values, ASCII characters or both.
  311. Hex number design:
  312.     Here you can choose if you prefer upper or  lower  case  characters 
  313.     for the hexadecimal part of the edit field.
  314. Border for Sizegadget:
  315.     Chooses the position of the wider border of the window  (either  at 
  316.     the right or at the bottom). Lets you  gain  some  more  horizontal 
  317.     pixels if you need them to display one more column.
  318. Clipboard:
  319.     Specify if you want internal or external clipboard  handling.  With 
  320.     external clipboard handling enabled, you can copy data to and  from 
  321.     other applications.
  322. Files:
  323.     Here you can choose the behavior of  Zaphod  when  loading  several 
  324.     files at one time. They can be completely  appended  to  the  other
  325.     file buffers, completely inserted or appended except the first  one 
  326.     which goes to the actual file buffer.
  327. Auto-resize window:
  328.     Re-calculates the window dimensions and proportions. Useful if  you 
  329.     have changed a font or the window size and  want  to  optimize  the 
  330.     window size now.
  331. Reset to default:
  332.     Resets all settings to the default settings.
  333. Load settings:
  334.     Loads the settings from the program icon. This doesn't work if  you 
  335.     have started the program from the shell.
  336. Save settings:
  337.     Saves the settings to the program icon. This doesn't  work  if  you 
  338.     have started the program from the shell.
  339.  
  340. 5.2.4 Files
  341.  
  342. Here you can directly choose each file buffer. There  is  always  one  menu 
  343. item with an ``(empty)'' file buffer which can be chosen to drop a file  by 
  344. its icon into it or load a new file from the ``Open'' menu.
  345.  
  346. 6. Credits
  347.  
  348. Thanks to all beta testers, who helped me much with sometimes detailed  bug 
  349. reports, suggestions or comments about the program style.
  350.  
  351. Special thanks goes to Albert Weinert  for  his  program  ``KitCat''  which 
  352. allows easy creation of localization catalogs, and to Dr. Peter Kittel  for 
  353. his ``Amiga-Glossar''.
  354.  
  355. 7. Bug reports and others
  356.  
  357. If you find errors (in the program itself or in the documentation), want to
  358. write a new language catalog for your language, want to have  new  features
  359. or the source code or have other suggestions, write to:
  360.  
  361.  
  362.                                Holger Schemel
  363.                                 Sennehof 28
  364.                          33659 Bielefeld (Senne I)
  365.                                   Germany                
  366.                        Phone: +49 (0)5 21 / 49 32 45
  367.  
  368.                                   E-Mail:
  369.                     aeglos@valinor.ms.sub.org (at home)
  370.                     aeglos@uni-paderborn.de (university)
  371.                  q99492@pbhrzx.uni-paderborn.de (university)
  372.  
  373.  
  374. E-Mail preferred.
  375.